<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Construct a tar/zip archive from the files within a directory</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="phardata.addfromstring.html">« PharData::addFromString</a></li>
      <li style="float: right;"><a href="phardata.buildfromiterator.html">PharData::buildFromIterator »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.phardata.html">PharData</a></li>
    <li>Construct a tar/zip archive from the files within a directory</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="phardata.buildfromdirectory" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PharData::buildFromDirectory</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL phar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::buildFromDirectory</span> &mdash; <span class="dc-title">Construct a tar/zip archive from the files within a directory</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phardata.buildfromdirectory-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>PharData::buildFromDirectory</strong></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$directory</code></span>, <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code><span class="initializer"> = &quot;&quot;</span></span>): <span class="type">array</span></div>


  <p class="para rdfs-comment">
   Populate a tar/zip archive from directory contents.  The optional second
   parameter is a regular expression (pcre) that is used to exclude files.
   Any filename that matches the regular expression will be included, all others will be
   excluded.  For more fine-grained control, use <span class="function"><a href="phardata.buildfromiterator.html" class="function">PharData::buildFromIterator()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phardata.buildfromdirectory-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt>
<code class="parameter">directory</code></dt>

     <dd>

      <p class="para">
       The full or relative path to the directory that contains all files
       to add to the archive.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">pattern</code></dt>

     <dd>

      <p class="para">
       An optional pcre regular expression that is used to filter the
       list of files.  Only file paths matching the regular expression
       will be included in the archive.
      </p>
     </dd>

    
   </dl>

  </p>

 </div>

 <div class="refsect1 returnvalues" id="refsect1-phardata.buildfromdirectory-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   <span class="function"><a href="phar.buildfromdirectory.html" class="function">Phar::buildFromDirectory()</a></span> returns an associative array
   mapping internal path of file to the full path of the file on the
   filesystem,  或者在失败时返回 <strong><code>false</code></strong>.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phardata.buildfromdirectory-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   This method throws <span class="classname"><a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a></span> when unable
   to instantiate the internal directory iterators,
   or a <span class="classname"><a href="class.pharexception.html" class="classname">PharException</a></span> if there were errors
   saving the phar archive.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-phardata.buildfromdirectory-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.1.0</td>
      <td>
       <span class="methodname"><strong>PharData::buildFromDirectory()</strong></span> no longer returns <strong><code>false</code></strong>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-phardata.buildfromdirectory-examples">
  <h3 class="title">范例</h3>
  <div class="example" id="example-763">
    <p><strong>示例 #1 A <span class="function"><strong>PharData::buildFromDirectory()</strong></span> example</strong></p>
  <div class="example-contents"><p>
   
  </p></div>
  <div class="example-contents"><p>
   <div class="example-contents">
    <div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$phar&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'project.tar'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//&nbsp;add&nbsp;all&nbsp;files&nbsp;in&nbsp;the&nbsp;project<br /></span><span style="color: #0000BB">$phar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">buildFromDirectory</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">'/project'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$phar2&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'project2.zip'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">//&nbsp;add&nbsp;all&nbsp;files&nbsp;in&nbsp;the&nbsp;project,&nbsp;only&nbsp;include&nbsp;php&nbsp;files<br /></span><span style="color: #0000BB">$phar2</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">buildFromDirectory</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">'/project'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'/\.php$/'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

  </p></div>
  </div>
 </div>



 <div class="refsect1 seealso" id="refsect1-phardata.buildfromdirectory-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="phar.buildfromdirectory.html" class="function" rel="rdfs-seeAlso">Phar::buildFromDirectory()</a> - Construct a phar archive from the files within a directory</span></li>
    <li class="member"><span class="function"><a href="phardata.buildfromiterator.html" class="function" rel="rdfs-seeAlso">PharData::buildFromIterator()</a> - Construct a tar or zip archive from an iterator</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>